home *** CD-ROM | disk | FTP | other *** search
/ PsL Monthly 1993 December / PSL Monthly Shareware CD-ROM (December 1993).iso / prgmming / dos / c / codelis.exe / MANUAL.DOC < prev    next >
Text File  |  1993-02-17  |  24KB  |  826 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.                             CODELISTER
  16.  
  17.      --------------------------------------------------------------
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.                                                       USER'S MANUAL
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45. MALCOLM MCDOWELL
  46. 85 Halley St
  47. Nepean Ontario
  48. K2J 3R5
  49.  
  50. (613) 825-8593
  51.  
  52.  
  53. .
  54.  
  55.  
  56.  
  57. WARRANTY
  58.  
  59. Users of "CodeLister" must accept this disclaimer of warranty:
  60. "CodeLister" is supplied as is.  The author disclaims all
  61. warranties, expressed or implied, including, without limitation,
  62. the warranties of merchantability and of fitness for any purpose.
  63. The author assumes no liability for damages, direct or conse-
  64. quential, which may result from the use of "CodeLister."
  65.  
  66.  
  67. USE RESTRICTIONS
  68.  
  69.  
  70. CodeLister is a "shareware program" and is provided at no charge
  71. to the user for evaluation.  Feel free to share it with your
  72. friends, but please do not give it away altered or as part of
  73. another system.  The essence of "user-supported" software is to
  74. provide personal computer users with quality software without
  75. high prices, and yet to provide incentive for programmers to
  76. continue to develop new products.  If you find this program
  77. useful and find that you are using CodeLister and continue to use
  78. CodeLister after a reasonable trial period, you must make a
  79. registration payment of $20.00 + Shipping and Handling (Canadian
  80. dollars) to Malcolm McDowell.  The $20.00 registration fee will
  81. license one copy for use on any one computer at any one time.
  82.  
  83. Commercial users of CodeLister must register and pay for their
  84. copies of CodeLister within 30 days of first use or their license
  85. is withdrawn.  Site-License arrangements may be made by
  86. contacting Malcolm McDowell.
  87.  
  88. Anyone distributing CodeLister for any kind of remuneration must
  89. first contact Malcolm McDowell at the address below for
  90. authorization.
  91.  
  92. This authorization will be automatically granted to distributors
  93. recognized by the (ASP) as adhering to its guidelines for
  94. shareware distributors, and such distributors may begin offering
  95. CODELISTER immediately (However Malcolm McDowell must still be
  96. advised so that the distributor can be kept up-to-date with the
  97. latest version of CodeLister.).
  98.  
  99. You are encouraged to pass a copy of CodeLister along to your
  100. friends for evaluation.  Please encourage them to register their
  101. copy if they find that they can use it.  All registered users
  102. will receive a copy of the latest version of the CodeLister
  103. package.
  104.  
  105.  
  106.                              OMBUDSMAN NOTICE
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116. This program is produced by a member of the Association of
  117. Software Professionals (ASP). ASP wants to make sure that the
  118. shareware principle works for you. If you are unable to resolve a
  119. shareware-related problem with an ASP member by contacting the
  120. member directly, ASP may be able to help. The ASP Ombudsman can
  121. help you resolve a dispute or problem with an ASP member, but
  122. does not provide technical support for members' products. Please
  123. write to the ASP Ombudsman at 545 Grover Road, Muskegon, MI 49442
  124. or send a CompuServe message via CompuServe Main to ASP Ombudsman
  125. 70007,3536.
  126.  
  127.  
  128.  
  129.  
  130.                              TABLE OF CONTENTS
  131.  
  132. CHAPTER 1  INTRODUCTION. . . . . . . . . . . . . . . . . . . . . . . . .  1
  133.  
  134.      1.1 SYSTEM REQUIREMENTS . . . . . . . . . . . . . . . . . . . . . .  1
  135.      1.2 FEATURES. . . . . . . . . . . . . . . . . . . . . . . . . . . .  1
  136.  
  137. CHAPTER 2  INSTALLATION. . . . . . . . . . . . . . . . . . . . . . . . .  3
  138.  
  139. CHAPTER 3  RUNNING CODELISTER. . . . . . . . . . . . . . . . . . . . . .  4
  140.  
  141.      3.1  Command Line Parameters. . . . . . . . . . . . . . . . . . . .  4
  142.           3.1.1 Printing Individual Files. . . . . . . . . . . . . . . .  4
  143.           3.1.2 Printing Project Files.. . . . . . . . . . . . . . . . .  4
  144.                3.1.2.1 Project File Extension. . . . . . . . . . . . . .  5
  145.                3.1.2.2 Creating Project Files. . . . . . . . . . . . . .  5
  146.      3.2  Definition of CodeLister Display.. . . . . . . . . . . . . . .  7
  147.           3.2.1 F1 - Set Configuration.. . . . . . . . . . . . . . . . .  8
  148.                3.2.1.1 Description of Configuration
  149.                     Parameters.. . . . . . . . . . . . . . . . . . . . .  8
  150.           3.2.2 F2 - Continue. . . . . . . . . . . . . . . . . . . . . . 11
  151.                3.2.2.1 Display of Files Printed. . . . . . . . . . . . . 11
  152.                3.2.2.2 Stopping the Printing of Files. . . . . . . . . . 11
  153.           3.2.3  F10 - Stop. . . . . . . . . . . . . . . . . . . . . . . 11
  154.  
  155. CHAPTER 4  DEFINITION OF LISTINGS. . . . . . . . . . . . . . . . . . . . 12
  156.  
  157. CHAPTER 5  ERROR MESSAGES. . . . . . . . . . . . . . . . . . . . . . . . 13
  158.  
  159. CHAPTER 6  REGISTRATION. . . . . . . . . . . . . . . . . . . . . . . . . 14
  160.  
  161. CHAPTER 1  INTRODUCTION
  162.  
  163.  
  164.  
  165.  
  166. 1.1 SYSTEM REQUIREMENTS
  167.  
  168. CodeLister is designed to run on DOS 4.00 or higher. A VGA
  169. monitor is recommended. The printers supported include standard
  170. graphics printers such as:
  171.  
  172.                EPSON
  173.                ROLAND
  174.  
  175. and laser printers such as:
  176.  
  177.                HP LASERJET II
  178.                HP LASERJET III.
  179.  
  180.  
  181. 1.2 FEATURES
  182.  
  183. CodeLister is a package used to support source code development
  184. and configuration management. Its features include:
  185.  
  186.      o    Formatted C source code printouts.
  187.  
  188.                CodeLister will take individual source files or
  189.                project files and format them for printing. This
  190.                prevents lines of text being printed on the
  191.                perforations or off the page.
  192.  
  193.      o    Each page is identified with a header.
  194.  
  195.                The header contains the file name, the date that
  196.                the file was edited and saved and the page number.
  197.                This allows you to identify printouts belonging to
  198.                a given date and configuration.
  199.  
  200.      o    Multiple Pages on a single sheet of paper.
  201.  
  202.                If you are using a laser printer, CodeLister can
  203.                generate listings that have one, two or four pages
  204.                on each sheet of paper. This is ideal for storing
  205.                old listings and saving paper.
  206.  
  207.                   - 1 -
  208.  
  209.      o    Table of Contents.
  210.  
  211.                A Table of Contents lists the functions and the
  212.                page in the listing where it is defined. This
  213.                allows you to quickly locate a function in the
  214.                listing or as a quick reference to function
  215.                parameters.
  216.  
  217.      o    Statistics
  218.  
  219.                The number of lines of code and the size in bytes
  220.            of the ASCII files.
  221.  
  222.                   - 2 -
  223.  
  224. CHAPTER 2  INSTALLATION
  225.  
  226.  
  227.  
  228.  
  229. To setup CodeLister perform the following steps:
  230.  
  231. 1)   CLIST.ZIP is a self-extracting file. Extract the files by
  232.      typing:
  233.  
  234.           CLIST
  235.  
  236.      at the DOS prompt.
  237.  
  238. 2)   A number of files will extracted. Refer to packing.lst for a
  239.      description of the files. The install.bat can be used to
  240.      install CodeLister. It assumes that you have a hard disk, or
  241.      c: drive. To continue, make sure that you are in the
  242.      directory or on the drive (ie a: or b:) containing the
  243.      install.bat file. To continue with the installation, type:
  244.  
  245.           INSTALL
  246.  
  247.      The installation will create a directory called C:\CLIST and
  248.      copy the files:
  249.  
  250.           CLIST.EXE and
  251.           CLIST.CFG
  252.  
  253.      to the directory.
  254.  
  255.  
  256. 3)   Add the directory to your path name. Use your editor to add
  257.      the path to autoexec.bat file. This is done by adding:
  258.  
  259.           ;c:\clist
  260.  
  261.      to the line that has "PATH=" in your autoexec.bat file.
  262.  
  263. Your are now ready to execute CodeLister from any directory on
  264. your computer.
  265.  
  266.  
  267. NOTE:
  268.  
  269.           CodeLister will create a configuration file from each
  270.           directory that you execute it from.
  271.  
  272.                   - 3 -
  273.  
  274.  
  275. CHAPTER 3  RUNNING CODELISTER
  276.  
  277.  
  278.  
  279.  
  280. The section describes how to run CodeLister. This version of
  281. CodeLister will create a configuration file in each directory
  282. that it is run from.
  283.  
  284. 3.1  Command Line Parameters.
  285.  
  286.      To run CodeLister one of two command line parameters must be